Announcement

End Points

Attribute

announcement_name

string

Announcement Name

announcement_format

integer

Format in which the announcement should be displayed

creation_time

integer

Announcement creation time

created_by_user

integer

Announcement created by user

last_modified_time

integer

Announcement modified time

collection_id

integer

Collection ID of the announcement

profile_id

integer

Profile ID of the announcement

last_modified_by_user

integer

Announcement modified by user

ack_button

string

Button text to be shown on the device for acknowledgement

announcement_id

integer

Unique ID representing announcement

is_moved_to_trash

integer

Is announcement deleted

needs_acknowledgement

string

Specify if the announcement needs acknowledgement from the device

announcement_detail

object

Announcement message details

Show Sub-Attributes

title_color

string

Title color of announcement

title

string

Title of announcement

nbar_icon

string

Message icon to be displayed on the notification bar

detail_message

string

Detailed message to be shown in the app

nbar_message

string

Detailed message to be shown in Notification bar

needs_acknowledgement

string

Specify if the announcement needs acknowledgement from the device

ack_button

string

Button text to be shown on the device for acknowledgement

[
    {
        "announcement_name": "Test announcement",
        "announcement_format": 1,
        "creation_time": 1603910052300,
        "created_by_user": "admin",
        "last_modified_time": 1603910052252,
        "collection_id": 9007199254741136,
        "profile_id": 9007199254740996,
        "last_modified_by_user": "admin",
        "ack_button": "Got It",
        "announcement_id": 9007199254740996,
        "is_moved_to_trash": false,
        "needs_acknowledgement": true,
        "announcement_detail": {
            "title_color": "#123123",
            "title": "Test announcement",
            "nbar_icon": "/images/announcement/nbaricon/info.png",
            "detail_message": "<p>Test announcement</p>",
            "nbar_message": "Test message",
            "needs_acknowledgement": true,
            "ack_button": "Got It"
        }
    }
]

Get All Announcements

Fetches all the announcements that have been created.
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/announcements

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "announcement": [
        {
            "announcement_name": "Test announcement",
            "announcement_format": 1,
            "creation_time": 1603910052300,
            "created_by_user": "admin",
            "last_modified_time": 1603910052252,
            "collection_id": 9007199254741136,
            "profile_id": 9007199254740996,
            "last_modified_by_user": "admin",
            "ack_button": "Got It",
            "announcement_id": 9007199254740996,
            "is_moved_to_trash": false,
            "needs_acknowledgement": true,
            "announcement_detail": {
                "title_color": "#123123",
                "title": "Test announcement",
                "nbar_icon": "/images/announcement/nbaricon/info.png",
                "detail_message": "<p>Test announcement</p>",
                "nbar_message": "Test message",
                "needs_acknowledgement": true,
                "ack_button": "Got It"
            }
        }
    ]
}

Create an announcement

Creates a new announcement.
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/announcements

Arguments

announcement_name

string

(Required)

Announcement Name

announcement_format

integer

(Required)

Format in which the announcement should be displayed

announcement_detail

object

(Required)

Announcement message details

Show Sub-Attributes

title_color

string

Title color of announcement

title

string

Title of announcement

nbar_icon

string

Message icon to be displayed on the notification bar

detail_message

string

Detailed message to be shown in the app

nbar_message

string

Detailed message to be shown in Notification bar

needs_acknowledgement

string

Specify if the announcement needs acknowledgement from the device

ack_button

string

Button text to be shown on the device for acknowledgement

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "announcement_name": "Test announcement",
    "announcement_format": 1,
    "announcement_detail": {
        "title_color": "#123123",
        "title": "Test announcement",
        "nbar_icon": "/images/announcement/nbaricon/info.png",
        "detail_message": "<p>Test announcement</p>",
        "nbar_message": "Test message",
        "needs_acknowledgement": true,
        "ack_button": "Got It"
    }
}

HTTP/1.1

{
    "announcement": [
        {
            "announcement_name": "Test announcement",
            "announcement_format": 1,
            "creation_time": 1603910052300,
            "created_by_user": "admin",
            "last_modified_time": 1603910052252,
            "collection_id": 9007199254741136,
            "profile_id": 9007199254740996,
            "last_modified_by_user": "admin",
            "ack_button": "Got It",
            "announcement_id": 9007199254740996,
            "is_moved_to_trash": false,
            "needs_acknowledgement": true,
            "announcement_detail": {
                "title_color": "#123123",
                "title": "Test announcement",
                "nbar_icon": "/images/announcement/nbaricon/info.png",
                "detail_message": "<p>Test announcement</p>",
                "nbar_message": "Test message",
                "needs_acknowledgement": true,
                "ack_button": "Got It"
            }
        }
    ]
}

Delete the Announcements

Deletes an announcement for given announcement IDs.
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/announcements

Arguments

announcement_id

integer

(Required)

Unique ID representing announcement

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "announcement_id": 9007199254740996
}

HTTP/1.1

{
    "announcement": [
        {
            "announcement_name": "Test announcement",
            "announcement_format": 1,
            "creation_time": 1603910052300,
            "created_by_user": "admin",
            "last_modified_time": 1603910052252,
            "collection_id": 9007199254741136,
            "profile_id": 9007199254740996,
            "last_modified_by_user": "admin",
            "ack_button": "Got It",
            "announcement_id": 9007199254740996,
            "is_moved_to_trash": false,
            "needs_acknowledgement": true,
            "announcement_detail": {
                "title_color": "#123123",
                "title": "Test announcement",
                "nbar_icon": "/images/announcement/nbaricon/info.png",
                "detail_message": "<p>Test announcement</p>",
                "nbar_message": "Test message",
                "needs_acknowledgement": true,
                "ack_button": "Got It"
            }
        }
    ]
}

Get Announcement details

Fetches the details of an announcement for a given announcement ID.
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/announcements/{announcement_id}

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "creation_time": 1603910052300,
    "last_modified_time": 1603910052252,
    "announcement_name": "Test announcement",
    "announcement_format": 1,
    "needs_acknowledgement": true,
    "last_modified_by_user": "admin",
    "no_of_devices_distributed": 0,
    "created_by_user": "admin",
    "no_of_groups_distributed": 0,
    "collection_id": 9007199254741136,
    "ack_button": "Got It",
    "is_moved_to_trash": false,
    "profile_id": 9007199254740996,
    "announcement_id": 9007199254740996,
    "announcement_detail": {
        "title_color": "#123123",
        "title": "Test announcement",
        "nbar_icon": "/images/announcement/nbaricon/info.png",
        "detail_message": "<p>Test announcement</p>",
        "nbar_message": "Test message",
        "needs_acknowledgement": true,
        "ack_button": "Got It"
    }
}

Modify Announcement

Modifies an existing announcement
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

PUT - /api/v1/mdm/announcements/{announcement_id}

Arguments

announcement_name

string

(Required)

Announcement Name

announcement_format

integer

(Required)

Format in which the announcement should be displayed

announcement_detail

object

(Required)

Announcement message details

Show Sub-Attributes

title_color

string

Title color of announcement

title

string

Title of announcement

nbar_icon

string

Message icon to be displayed on the notification bar

detail_message

string

Detailed message to be shown in the app

nbar_message

string

Detailed message to be shown in Notification bar

needs_acknowledgement

string

Specify if the announcement needs acknowledgement from the device

ack_button

string

Button text to be shown on the device for acknowledgement

curl --request PUT \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "announcement_name": "Test announcement",
    "announcement_format": 1,
    "announcement_detail": {
        "title_color": "#123123",
        "title": "Test announcement",
        "nbar_icon": "/images/announcement/nbaricon/info.png",
        "detail_message": "<p>Test announcement</p>",
        "nbar_message": "Test message",
        "needs_acknowledgement": true,
        "ack_button": "Got It"
    }
}

HTTP/1.1

{
    "creation_time": 1603910052300,
    "last_modified_time": 1603910052252,
    "announcement_name": "Test announcement",
    "announcement_format": 1,
    "needs_acknowledgement": true,
    "last_modified_by_user": "admin",
    "no_of_devices_distributed": 0,
    "created_by_user": "admin",
    "no_of_groups_distributed": 0,
    "collection_id": 9007199254741136,
    "ack_button": "Got It",
    "is_moved_to_trash": false,
    "profile_id": 9007199254740996,
    "announcement_id": 9007199254740996,
    "announcement_detail": {
        "title_color": "#123123",
        "title": "Test announcement",
        "nbar_icon": "/images/announcement/nbaricon/info.png",
        "detail_message": "<p>Test announcement</p>",
        "nbar_message": "Test message",
        "needs_acknowledgement": true,
        "ack_button": "Got It"
    }
}

Delete Announcement

Deletes an announcement for a specific announcement ID.
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/announcements/{announcement_id}

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "creation_time": 1603910052300,
    "last_modified_time": 1603910052252,
    "announcement_name": "Test announcement",
    "announcement_format": 1,
    "needs_acknowledgement": true,
    "last_modified_by_user": "admin",
    "no_of_devices_distributed": 0,
    "created_by_user": "admin",
    "no_of_groups_distributed": 0,
    "collection_id": 9007199254741136,
    "ack_button": "Got It",
    "is_moved_to_trash": false,
    "profile_id": 9007199254740996,
    "announcement_id": 9007199254740996,
    "announcement_detail": {
        "title_color": "#123123",
        "title": "Test announcement",
        "nbar_icon": "/images/announcement/nbaricon/info.png",
        "detail_message": "<p>Test announcement</p>",
        "nbar_message": "Test message",
        "needs_acknowledgement": true,
        "ack_button": "Got It"
    }
}

Get Announcement distribution to group details

Fetches the Group IDs to which the announcement is distributed.
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/announcements/{announcement_id}/groups

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "groups": [
        "1",
        "2",
        "3"
    ]
}

Distribute Announcement to groups

Distributes an announcement to given group IDs.
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/announcements/{announcement_id}/groups

Arguments

group_ids

array

(Required)

Array of group IDs

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "group_ids": [
        "1",
        "2",
        "3"
    ]
}

HTTP/1.1

{
    "groups": [
        "1",
        "2",
        "3"
    ]
}

Remove announcement from group

Disassociates the announcement from the given group IDs.
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/announcements/{announcement_id}/groups

Arguments

group_ids

array

(Required)

Array of group IDs

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/groups \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "group_ids": [
        "1",
        "2",
        "3"
    ]
}

HTTP/1.1

{
    "groups": [
        "1",
        "2",
        "3"
    ]
}

Distribute announcement to devices

Distributes an announcement to the given device IDs.
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/announcements/{announcement_id}/devices

Arguments

device_ids

array

(Required)

Array of device IDs

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/devices \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "device_ids": [
        "1",
        "2",
        "3"
    ]
}

HTTP/1.1

{
    "groups": [
        "1",
        "2",
        "3"
    ]
}

Remove announcement from devices

Disassociates the announcement from the given device IDs.
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/announcements/{announcement_id}/devices

Arguments

device_ids

array

(Required)

Array of device IDs

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/devices \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "device_ids": [
        "1",
        "2",
        "3"
    ]
}

HTTP/1.1

{
    "groups": [
        "1",
        "2",
        "3"
    ]
}

Get Announcement distribution to device details

Fetches the device IDs to which the announcement is distributed.
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/announcements/{announcement_id}/device

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/announcements/9007199254740996/device \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "devices": [
        "1",
        "2",
        "3"
    ]
}